类 FoxitPDFSDKPython3.SetOCGStateAction 继承关系图:

Public 成员函数
def	SetOCGStateAction (action)
	构造函数，使用父类对象。更多...

def	GetOCGState (index)
	获取OCG的状态。更多...

def	GetOCGStateArray (index)
	获取OCG字典数组。更多...

def	GetOCGStateCount ()
	获取OCG状态的数量。更多...

def	InsertOCGStates (document, index, state, ocg_dict_array)
	将OCG状态插入到动作中。更多...

def	IsRadioButtonStatePreserved ()
	获取单选按钮保留状态。更多...

def	RemoveOCGStates (index)
	移除OCG状态。更多...

def	ReplaceOCGStates (document, index, ocg_dict_array)
	替换OCG状态数组。更多...

def	SetRadioButtonStatePreserved (is_preserved)
	设置单选按钮保留状态。更多...

Public 成员函数继承自 FoxitPDFSDKPython3.Action
def	Action (action)
	构造函数，使用另一个动作对象。更多...

def	GetDict ()
	获取当前对象的PDF字典。更多...

def	GetDocument ()
	获取当前动作所属的PDF文档。更多...

def	GetSubAction (index)
	按索引获取子动作。更多...

def	GetSubActionCount ()
	获取子动作的数量。更多...

def	GetType ()
	获取动作类型。更多...

def	InsertSubAction (index, sub_action)
	在指定索引位置插入新的子动作。更多...

def	IsEmpty ()
	检查当前对象是否为空。更多...

def	RemoveAllSubActions ()
	移除所有子动作。更多...

def	RemoveSubAction (index)
	移除指定索引的子动作。更多...

def	SetSubAction (index, sub_action)
	按索引设置子动作。更多...

静态 Public 属性
	e_OCGStateOff = _fsdk.SetOCGStateAction_e_OCGStateOff
	将后续组的状态设置为OFF。

	e_OCGStateOn = _fsdk.SetOCGStateAction_e_OCGStateOn
	将后续组的状态设置为ON。

	e_OCGStateToggle = _fsdk.SetOCGStateAction_e_OCGStateToggle
	反转后续组的状态。

静态 Public 属性继承自 FoxitPDFSDKPython3.Action
	e_NewWindowFlagFalse = _fsdk.Action_e_NewWindowFlagFalse
	"NewWindow"标志为false。

	e_NewWindowFlagNone = _fsdk.Action_e_NewWindowFlagNone
	无"NewWindow"标志。

	e_NewWindowFlagTrue = _fsdk.Action_e_NewWindowFlagTrue
	"NewWindow"标志为true。

	e_TypeGoto = _fsdk.Action_e_TypeGoto
	动作类型：转到动作。

	e_TypeGoTo3DView = _fsdk.Action_e_TypeGoTo3DView
	动作类型：转到3D视图动作。

	e_TypeGoToE = _fsdk.Action_e_TypeGoToE
	动作类型：嵌入转到动作。

	e_TypeGoToR = _fsdk.Action_e_TypeGoToR
	动作类型：远程转到动作。

	e_TypeHide = _fsdk.Action_e_TypeHide
	动作类型：隐藏动作。

	e_TypeImportData = _fsdk.Action_e_TypeImportData
	动作类型：导入数据动作。

	e_TypeJavaScript = _fsdk.Action_e_TypeJavaScript
	动作类型：JavaScript动作。

	e_TypeLaunch = _fsdk.Action_e_TypeLaunch
	动作类型：启动动作。

	e_TypeMovie = _fsdk.Action_e_TypeMovie
	动作类型：电影动作。

	e_TypeNamed = _fsdk.Action_e_TypeNamed
	动作类型：命名动作。

	e_TypeRendition = _fsdk.Action_e_TypeRendition
	动作类型：演示动作。

	e_TypeResetForm = _fsdk.Action_e_TypeResetForm
	动作类型：重置表单动作。

	e_TypeSetOCGState = _fsdk.Action_e_TypeSetOCGState
	动作类型：设置OCG状态动作。

	e_TypeSound = _fsdk.Action_e_TypeSound
	动作类型：声音动作。

	e_TypeSubmitForm = _fsdk.Action_e_TypeSubmitForm
	动作类型：提交表单动作。

	e_TypeThread = _fsdk.Action_e_TypeThread
	动作类型：线程动作。

	e_TypeTrans = _fsdk.Action_e_TypeTrans
	动作类型：过渡动作。

	e_TypeUnknown = _fsdk.Action_e_TypeUnknown
	动作类型：未知动作。

	e_TypeURI = _fsdk.Action_e_TypeURI
	动作类型：统一资源标识符(URI)动作。

额外继承的成员函数
静态 Public 成员函数继承自 FoxitPDFSDKPython3.Action
def	Create (document, action_type)
	为指定的动作类型创建新动作。更多...

详细描述

设置OCG状态动作是设置一个或多个可选内容组的状态。(更多详情，请参考 <PDF参考1.7> P667 "设置OCG状态动作") 类FoxitPDFSDKPython3.SetOCGStateAction 派生自Action ，提供用于获取/设置设置OCG状态动作数据的函数。

参见: Action

构造及析构函数说明

◆ SetOCGStateAction()

def FoxitPDFSDKPython3.SetOCGStateAction.SetOCGStateAction ( action )

构造函数，使用父类对象。

参数

[in] action 父类对象。

成员函数说明

◆ GetOCGState()

def FoxitPDFSDKPython3.SetOCGStateAction.GetOCGState ( index )

获取OCG的状态。

参数

[in] index OCG状态的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython3.SetOCGStateAction.GetOCGStateCount 返回。

返回: OCG的状态。

◆ GetOCGStateArray()

def FoxitPDFSDKPython3.SetOCGStateAction.GetOCGStateArray ( index )

获取OCG字典数组。

参数

[in] index OCG状态的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython3.SetOCGStateAction.GetOCGStateCount 返回。

返回: OCG字典数组。

◆ GetOCGStateCount()

def FoxitPDFSDKPython3.SetOCGStateAction.GetOCGStateCount ( )

获取OCG状态的数量。

返回: OCG状态的数量。

◆ InsertOCGStates()

def FoxitPDFSDKPython3.SetOCGStateAction.InsertOCGStates	(	document,
		index,
		state,
		ocg_dict_array
	)

将OCG状态插入到动作中。

参数

[in]	document	有效的PDF文档对象。
[in]	index	要插入的OCG的索引。OCG状态将在该索引之后插入。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython3.SetOCGStateAction.GetOCGStateCount 返回。如果此值小于0或当前动作中OCG状态的数量为0，参数state将被插入到第一个位置。如果此值大于当前动作中OCG状态的数量，参数state将被添加到末尾。
[in]	state	要插入的OCG状态。
[in]	ocg_dict_array	要插入的OCG字典数组。

返回: 插入的OCG状态的索引。

◆ IsRadioButtonStatePreserved()

def FoxitPDFSDKPython3.SetOCGStateAction.IsRadioButtonStatePreserved ( )

获取单选按钮保留状态。

如果为true，表示当应用State数组中的状态时，应保留可选内容组之间的单选按钮状态关系。如果为false，则忽略单选按钮状态关系（如果有的话）。默认值：true。

返回: 保留状态值。

◆ RemoveOCGStates()

def FoxitPDFSDKPython3.SetOCGStateAction.RemoveOCGStates ( index )

移除OCG状态。

参数

[in] index 要移除的OCG的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython3.SetOCGStateAction.GetOCGStateCount 返回。

返回: 无。

◆ ReplaceOCGStates()

def FoxitPDFSDKPython3.SetOCGStateAction.ReplaceOCGStates	(	document,
		index,
		ocg_dict_array
	)

替换OCG状态数组。

参数

[in]	document	有效的PDF文档对象。
[in]	index	要替换的OCG的索引。有效范围：从0到(count-1)。 count由函数FoxitPDFSDKPython3.SetOCGStateAction.GetOCGStateCount 返回。
[in]	ocg_dict_array	要插入的OCG字典数组。

返回: true表示成功，而false表示失败。

◆ SetRadioButtonStatePreserved()

def FoxitPDFSDKPython3.SetOCGStateAction.SetRadioButtonStatePreserved ( is_preserved )

设置单选按钮保留状态。

参数

[in] is_preserved 保留状态值。

返回: 无。

Public 成员函数

静态 Public 属性

额外继承的成员函数

详细描述

构造及析构函数说明

◆ SetOCGStateAction()

成员函数说明

◆ GetOCGState()

◆ GetOCGStateArray()

◆ GetOCGStateCount()

◆ InsertOCGStates()

◆ IsRadioButtonStatePreserved()

◆ RemoveOCGStates()

◆ ReplaceOCGStates()

◆ SetRadioButtonStatePreserved()